Skip to content

feat: check service api contracts in ci - #973

Closed
hyoban wants to merge 1 commit into
feat/service-api-validation-navigationfrom
feat/service-api-contract-ci
Closed

hyoban wants to merge 1 commit into
feat/service-api-validation-navigationfrom
feat/service-api-contract-ci

Conversation

@hyoban

@hyoban hyoban commented Aug 25, 2026 •

Copy link
Copy Markdown
Member

Summary

  • add pull request checks against the reviewed Dify revision and generated-spec digest
  • check Dify main on schedule or manual dispatch so upstream contract additions flow into the docs
  • reject stale overlays, composition drift, and wire-contract differences
  • run localized spec lint, parity, coverage, and unit tests in CI

Companion backend PR: langgenius/dify#41248

Validation

  • workflow YAML parsed successfully
  • full API pipeline suite passed on the preceding stack layer

@hyoban
hyoban force-pushed the feat/service-api-contract-ci branch from 1e8899b to 4eee341 Compare August 25, 2026 14:25
@hyoban
hyoban changed the base branch from feat/service-api-localized-composition to feat/service-api-validation-navigation August 25, 2026 14:25
@hyoban
hyoban marked this pull request as ready for review August 25, 2026 14:34
@hyoban
hyoban requested a review from RiskeyL as a code owner August 25, 2026 14:34
Copilot AI lite review requested due to automatic review settings August 25, 2026 14:34
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. enhancement New feature or request labels Aug 25, 2026
@hyoban
hyoban marked this pull request as draft August 25, 2026 14:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated GitHub Actions workflow to continuously validate the Service API OpenAPI specs in this docs repo against Dify’s generated Service API contract, ensuring localized specs stay in sync and overlays don’t mask upstream changes.

Changes:

  • Introduces .github/workflows/check_service_api.yml to run spec lint/parity/coverage/unit checks and compare against a Dify-generated service-openapi.json.
  • Adds scheduled and dispatch-based checks so upstream Dify contract changes can be detected proactively (in addition to PR/push validation).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +67 to +70
- uses: actions/checkout@v4

- name: Resolve Dify source
id: dify-source
@hyoban hyoban closed this Aug 25, 2026
@RiskeyL
RiskeyL deleted the feat/service-api-contract-ci branch October 26, 2026 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants